Skip to content

feat(Icons): add OctIcon component #5248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 7 commits into from
Jan 29, 2025
Merged

feat(Icons): add OctIcon component #5248

merged 7 commits into from
Jan 29, 2025

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 29, 2025 •
edited by sourcery-ai bot
Loading

add OctIcon component

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符；如果有关联 Issue 请在下方填写相关编号

Description

fixes #5237

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

New Features:

  • Introduce the OctIcon component, which provides a set of OctIcons.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 29, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request introduces the OctIcon component to the application. It includes a new razor component, a demo page, and necessary configurations.

Class diagram for OctIcon component addition

classDiagram
    class OctIcons {
    }
    class DemoMenuItem {
        +string Text
        +string Url
        +bool IsNew
    }
    note for OctIcons "New component for displaying Oct icons"
    note for DemoMenuItem "Updated with new Oct icon menu item"
Loading

File-Level Changes

Change Details Files
Added OctIcon component and demo page.
  • Created OctIcons.razor component to display Octicons.
  • Created OctIcons.razor.cs for the component's code-behind.
  • Added a new route /oct-icon for the demo page.
 src/BootstrapBlazor.Server/Components/Samples/Icons/OctIcons.razor
src/BootstrapBlazor.Server/Components/Samples/Icons/OctIcons.razor.cs
Updated menu to include OctIcon demo.
  • Added a new menu item for OctIcon demo.
  • Set the IsNew property to true for the new menu item.
 src/BootstrapBlazor.Server/Extensions/MenusLocalizerExtensions.cs
Updated localization files.
  • Added localization strings for the OctIcon demo page in both English and Chinese.
 src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json
Added a project reference to BootstrapBlazor.OctIcon.
  • Added a project reference to BootstrapBlazor.OctIcon.
 src/BootstrapBlazor.Server/BootstrapBlazor.Server.csproj

Assessment against linked issues

Issue Objective Addressed Explanation
#5237 Add Octicons set as a new icon library similar to Font Awesome ✅
#5237 Provide documentation and example usage for the new Octicon component ✅
#5237 Integrate Octicons into the existing icon library/demo pages ✅
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added the enhancement New feature or request label Jan 29, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Jan 29, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jan 29, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please complete all sections of the PR template, particularly the Risk and Verification sections, to help reviewers understand the impact of these changes.
  • Consider adding unit tests for the new OctIcon component to ensure proper functionality and prevent regressions.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link

codecov bot commented Jan 29, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (adc3e46) to head (e48b797).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff            @@
##              main     #5248   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          639       639           
  Lines        28771     28771           
  Branches      4082      4082           
=========================================
  Hits         28771     28771

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ArgoZhang ArgoZhang merged commit 10fe382 into main Jan 29, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the chore-octicon branch January 29, 2025 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees

@ArgoZhang ArgoZhang

Labels

enhancement New feature or request

Projects

None yet

Milestone

v9.3.0

Development

Successfully merging this pull request may close these issues.

feat(Icons): add Octicons set

2 participants

@ArgoZhang